/get-status

https://[domain]/ws/fb/get-status

  • Service is used to poll for status using the previously uploaded instruction set.

  • HTTP Request Type: POST

Name Type Description

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

instruction_set_id

Encrypted and signed file, encoded in base64. File will include the id of the instruction that was previously uploaded. No XML tags should be included.

Example: If instruction set id was 12345678, this is what you will encrypt.

Our system expects a plain text file, encrypted-signed and base64-encoded.

Unlike Application XML, with DAM F&B our system accepts one and only one file at a time (multiple transactions can be inside). Therefore, it is not necessary to use any wrapper (tar, zip, etc.) to put 2 or more files in one upload.

JSON Request

Copy 
{
  "CSID":"<client-service-id>",
  "instruction_set_id ":"<encrypted and signed  file, encoded in base64>"
}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/fb/get-status -d '{"CSID":"testerCSID", "instruction_set_id":"
Gye0cQWpqaXp5aUnvUXHOGGVIQAJoJS2TeUymc/Xq5a0DMFCUk/EStTuLSHvxMOLoowBBl8BwueD2iyntVf+6iXGOz+/WAM/+Y/KheszZOWfasdfawe235afuD2Li2LT3RzRuxzlpi7CXgIQvqOVzWsSoB6mn/jK6BRRNWEXPhzmNgQB/gVReN"}
Name Type Description

timestamp

YYYY-MM-DD HH:MM:SS

Date/Time which the request was processed at.

request_status

ERROR

UNKNOWN

REQUEST_REJECTED

REQUEST_ACCEPTED_FOR_PROCESSING

 

ERROR: json message could not be parsed (hence nothing could be processed)

UNKNOWN: due to some capacity limits status could not be retrieved now and is to be retried later (should not be any frequent).

REQUEST_REJECTED: all transactions were rejected (didn’t pass initial screening)

REQUEST_ACCEPTED_FOR_PROCESSING: all transactions in the request could be parsed, passed the initial screening and put into the batch processing queue

REQUEST_PART_ACCEPTED_FOR_PROCESSING: as above, but some transactions were rejected.

processing_stats

 

Displays processing status. Only appears if the XML request could be decoded and parsed.

instruction_set_id

ID of the request file that was processed.

ID is a unique identifier which you create for each funding request.

trans_provided

Numeric

Number instructions included within the request.

trans_read

Numeric

Number of instructions that were parsed by the system.

trans_understood

Numeric

Number of instructions that were processed by the system

trans_rejected

Numeric

Number of instructions that were parsed but were unable to be processed.

details

Base64-encoded, PGP encrypted and signed XML containing instruction result set.

If XML could be parsed, will contain information on each individual transaction status (per XML Request Schema).

 

error_code / error_message

Present if request_status is ERROR or REQUEST_REJECTED (in case XML could not be processed)

If JSON or XML could not be processed these fields will be present and will describe the issue

JSON Response

Copy 
{
  "timestamp": "<timestamp>",
   "request_status":"<request_status>":
    {
       "instruction_set_id":<instruction_id>, 
       "trans_provided": <trans_provided>,
        "trans_read": <trans_read>,
        "trans_understood":<trans_understood> ,
        "trans_rejected": <trans_rejected>
     },
    "details":"<base64-encoded, PGP encrypted and signed XML containing instruction result set>"
}

Sample

Copy 
{
  "timestamp":"2017.12.21-06:21:37",
   "request_status":"REQUEST_[PARTIALLY]_ACCEPTED_FOR_PROCESSING",
   "processing_stats":
    {
       "instruction_set_id":786, 
       "trans_provided":1,
        "trans_read":1,
        "trans_understood":1,
        "trans_rejected":0
     },
    "details":"<base64-encoded, PGP encrypted and signed XML containing instruction result set>"
}